stm32lib: Add workflow documentation for updating vendor versions. #28
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrewleech
force-pushed
the
readme-workflow-improvements
branch
6 times, most recently
from
29033f6 to
0b14eec
Compare
This adds a step-by-step guide for updating MCU series to new vendor versions, making the vendor/work branch workflow more accessible. The new section covers: - Cloning/fetching upstream STM32Cube repositories. - Using `fetch_from_upstream.sh` to import vendor code. - Proper commit message format (tags are created by maintainers). - Creating work branches and rebasing MicroPython patches. - Pushing and creating pull requests.
dpgeorge
force-pushed
the
readme-workflow-improvements
branch
from
0b14eec to
8d9e35e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the README.md documentation by:
The new "Updating to a new vendor version" section covers:
fetch_from_upstream.shto import vendor codeThis makes the workflow more accessible to contributors and reduces the risk of manual errors when updating vendor libraries.
Testing
Documentation-only change. The instructions have been validated through successful execution of the WB v1.23.0 update (see PR #27).
Trade-offs and Alternatives
N/A - pure documentation improvement with no code changes.